<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gimpbrushes: GIMP 3 Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GIMP 3 Library Reference Manual">
<link rel="up" href="libgimp-data.html" title="Data Objects">
<link rel="prev" href="libgimp3-gimpbrush.html" title="gimpbrush">
<link rel="next" href="libgimp3-gimpdynamics.html" title="gimpdynamics">
<meta name="generator" content="GTK-Doc V1.33.0 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#libgimp3-gimpbrushes.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libgimp-data.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libgimp3-gimpbrush.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libgimp3-gimpdynamics.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgimp3-gimpbrushes"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgimp3-gimpbrushes.top_of_page"></a>gimpbrushes</span></h2>
<p>gimpbrushes — Functions for manipulating brushes.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libgimp3-gimpbrushes.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpbrushes.html#gimp-brushes-refresh" title="gimp_brushes_refresh ()">gimp_brushes_refresh</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> **
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpbrushes.html#gimp-brushes-get-list" title="gimp_brushes_get_list ()">gimp_brushes_get_list</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgimp3-gimpbrushes.description"></a><h2>Description</h2>
<p>Functions related to getting and setting brushes.</p>
</div>
<div class="refsect1">
<a name="libgimp3-gimpbrushes.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gimp-brushes-refresh"></a><h3>gimp_brushes_refresh ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_brushes_refresh (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Refresh current brushes. This function always succeeds.</p>
<p>This procedure retrieves all brushes currently in the user's brush
path and updates the brush dialogs accordingly.</p>
<div class="refsect3">
<a name="gimp-brushes-refresh.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brushes-get-list"></a><h3>gimp_brushes_get_list ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> **
gimp_brushes_get_list (<em class="parameter"><code>const <span class="type">gchar</span> *filter</code></em>,
                       <em class="parameter"><code><span class="type">gint</span> *num_brushes</code></em>);</pre>
<p>Retrieve a complete listing of the available brushes.</p>
<p>This procedure returns a complete listing of available GIMP brushes.
Each name returned can be used as input to the
<a class="link" href="libgimp3-gimpcontext.html#gimp-context-set-brush" title="gimp_context_set_brush ()"><code class="function">gimp_context_set_brush()</code></a> procedure.</p>
<div class="refsect3">
<a name="gimp-brushes-get-list.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>filter</p></td>
<td class="parameter_description"><p>An optional regular expression used to filter the list.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_brushes</p></td>
<td class="parameter_description"><p>The number of brushes in the brush list. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-brushes-get-list.returns"></a><h4>Returns</h4>
<p>The list of brush names.
The returned value must be freed with <code class="function">g_strfreev()</code>. </p>
<p><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=num_brushes][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gchar*][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.0</div>
</body>
</html>